home *** CD-ROM | disk | FTP | other *** search
/ Aminet 41 / Aminet 41 (2001)(Schatztruhe)[!][Feb 2001].iso / Aminet / game / role / sangband.lha / Sangband095b / readme < prev    next >
Text File  |  1998-07-30  |  9KB  |  222 lines
  1. This is the README file for SAngband 0.9.5 (beta 1) (05/12/98)
  2.  
  3. SAngband 0.9.5 is based on Angband 2.8.3 (beta 1 is not yet)
  4.  
  5. This version is very experimental.  While I do not believe it to be
  6. particularly buggy, it has been extensively re-balanced, usually with
  7. numbers pulled out of thin air, so it may be considerably harder or
  8. easier than previous versions.  Read the file "changes.txt" for
  9. information on changes from earlier versions.
  10.  
  11. AN IMPORTANT NOTE: SAngband 0.9.5 can NOT read save files from earlier
  12. versions.  My apologies, but the changes to the internal structure of
  13. the game were too great to allow characters to translate easily.
  14.  
  15. Read lib/help/birth.txt for information on skills and talents,
  16. and lib/help/command.txt for information on the new commands.
  17.  
  18. A known bug:
  19.     Objects that give bonuses to various abilities may display a
  20.     larger bonus than they actually give.
  21.  
  22. === General information ===
  23.  
  24. SAngband is a "graphical" dungeon adventure game using textual characters
  25. to represent the walls and floors of a dungeon and the inhabitants therein,
  26. in the vein of "rogue", "hack", "nethack", and "moria".  There are no
  27. character "classes" in SAngband; characters become more powerful by using
  28. experience to advance "skills."
  29.  
  30. There are extensive ascii "on line help" files in the "lib/help" directory.
  31.  
  32. This version of SAngband *should* run on Macintosh, Windows, Unix
  33. (X11/Curses), Linux (X11/Curses), Acorn, Amiga, various IBM machines, and
  34. others.  However, I've only tested it on Linux with Curses, but I haven't
  35. messed with anything system-specific.
  36.  
  37. See Makefile, h-config.h, and config.h for details on compiling.
  38. See "Makefile.xxx" and "main-xxx.c" for various supported systems.
  39.  
  40. Visit the SAngband Home Page ("http://www.fragment.com/~jl8e/sangband/"),
  41. the Angband Home Page ("http://www.phial.com/angband/"), and 
  42. browse through the Angband newsgroup ("rec.games.roguelike.angband").
  43.  
  44. Send bug reports, suggestions, etc, to Julian Lighton ("jl8e@fragment.com").
  45. I would really like to hear suggestions on adjusting the game balance.
  46.  
  47. === Quick and dirty compilation instructions (for Unix) === 
  48.  
  49. Step 1: Acquire.  Ftp to "export.andrew.cmu.edu:/angband/Variant"
  50.                   Try "bin" and "mget sangband*.tar.gz" and "y"
  51. Step 2: Extract.  Try "gunzip *.gz" then "tar -xvf *.tar"
  52. Step 3: Prepare.  Try "cd sangband*/src", then edit "Makefile"
  53.                   You may also edit "h-config.h" and "config.h"
  54. Step 4: Compile.  Try "make", and then "cd .." if successful
  55. Step 5: Execute.  Try "sangband -uTest" to initialize stuff
  56. Step 6: Play....  Read the "online help" via the "?" command.
  57.  
  58.  
  59. === Special instructions for other systems ===
  60.  
  61. The Macintosh requires that the "lib" folder be in the same folder as
  62. the executable.  Also, note that System 7.5 (and perhaps others) are
  63. brain damaged, and may default to the incorrect folder for opening
  64. savefiles.  Make sure you keep all your savefiles in the proper place,
  65. and if you load a savefile from the wrong place, note that the game
  66. may decide to re-save your savefile in the proper place when you quit.
  67. === Directory "src" ===
  68.  
  69. The "src" directory contains the complete set of source files.
  70.  
  71. The "main-???.c" and "Makefile.???" allow compilation on various systems.
  72.  
  73. Some of these systems (Macintosh, Windows) require "extra" files, most of
  74. which are located elsewhere (except for the "A-mac-h.*" Macintosh files).
  75.  
  76.  
  77. === Directory "lib" ===
  78.  
  79. The "lib" directory contains all of Angband's special sub-directories.
  80.  
  81.  
  82. === Directory "lib/apex" ===
  83.  
  84. The "lib/apex" directory contains the "high score" files.
  85.  
  86. The "scores.raw" file contains the "high score" table, in a "semi-binary"
  87. form,
  88. that is, all the bytes in the file are normal ascii values, but this includes
  89. the special "nul" or "zero" byte, which is used to separate and pad records.
  90. You should probably not attempt to modify this file with a normal text
  91. editor.
  92. This file should be (more or less) portable between different platforms.  It
  93. must be present (or creatable) for the game to run correctly.
  94.  
  95.  
  96. === Directory "lib/data" ===
  97.  
  98. The "lib/data" directory contains various special binary data files.
  99.  
  100. The files 'f_info.raw', 'k_info.raw', 'a_info.raw', 'e_info.raw',
  101. 'r_info.raw',
  102. and 'v_info.raw' are binary image files constructed by parsing the ascii
  103. template files in "lib/edit", described below.  These files are required,
  104. but can be created by the game if the "lib/edit" directory contains the
  105. proper files, and if the game was compiled to allow this creation.
  106.  
  107.  
  108. === Directory "lib/edit" ===
  109.  
  110. The "lib/edit" directory contains various special ascii data files.
  111.  
  112. The files 'f_info.txt', 'k_info.txt', 'a_info.txt', 'e_info.txt',
  113. 'r_info.txt',
  114. and 'v_info.txt' are ascii template files used to construct the binary image
  115. files in "lib/data", described above.  These files describe the "terrain
  116. features", "object kinds", "artifacts", "ego-items", "monster races", and
  117. "dungeon vaults", respectively.
  118.  
  119. The ascii template files are easier to edit than hard-coded arrays, and also
  120. prevent compilation errors on some machines, and also shrink the size of the
  121. binary executable, and also provide a user-readible spoiler file of sorts.
  122.  
  123. These files are optional if the game is distributed with pre-created
  124. binary raw files in "lib/data".
  125.  
  126.  
  127. === Directory "lib/file" ===
  128.  
  129. The "lib/file" directory contains various special ascii data files.
  130.  
  131. The 'news.txt' file is displayed to the user when the game starts up.  It
  132. contains basic information such as my name and email address, and the names
  133. of some of the people who have been responsible for previous versions of
  134. Angband.  You may edit this file (slightly) to include local "site specific"
  135. information such as who compiled the local executable.  You should refer the
  136. user to a special "online help" file, if necessary, that describes any local
  137. modifications in detail.  The first two lines of this file should be blank,
  138. and only the next 20 lines should contain information.
  139.  
  140. The 'dead.txt' file is displayed to the user when the player dies.  It
  141. contains a picture of a tombstone which is filled in with interesting
  142. information about the dead player.  You should not edit this file.
  143.  
  144. The optional file 'wizards.txt' may be used to specify which users may enter
  145. 'wizard' mode.  A missing file provides no restrictions, and an empty file
  146. prevents everyone from entering 'wizard' mode.  This file is only used on
  147. multi-user machines, otherwise there are no restrictions.
  148.  
  149. The optional file 'time.txt' may be used to restrict the "times" at which
  150. the game may be played, by providing specification of which hours of each day
  151. of the week are legal for playing the game.  See 'files.c' for more details.
  152. A missing file provides no restrictions, and an empty file will, by default,
  153. forbid the playing of the game from 8am-5pm on weekdays.  This file is only
  154. used on multi-user machines, and only if CHECK_TIME is defined, otherwise,
  155. there are no restrictions.
  156.  
  157. The optional file 'load.txt' may be used to restrict the "load" which
  158. the game may impose on the system.  See 'files.c' for more details.  A
  159. missing file provides no restrictions, and an empty file will, by
  160. default, restrict the "current load" to a maximal value of 100*FSCALE.
  161. This file is only used on multi-user machines, and only if CHECK_LOAD
  162. is defined, otherwise, there are no restrictions.
  163.  
  164.  
  165. === Directory "lib/help" ===
  166.  
  167. The "lib/help" directory contains the "online help" files.
  168.  
  169. This directory is used to search for normal "on line help" files.
  170.  
  171.  
  172. === Directory "lib/info" ===
  173.  
  174. The "lib/info" directory (optional) contains the "spoiler" files.
  175.  
  176. This directory is used to search for any "on line help" file that cannot
  177. be found in the "lib/help" directory.
  178.  
  179. The user may "redirect" this directory to point at any available directory.
  180.  
  181. Note that the default "help.hlp" file allows the "9" key to access a help
  182. file called "spoiler.hlp", and allows the "0" key to access "user.hlp".
  183.  
  184. These special help files can thus be placed in the user's own "info"
  185. directory to allow the on line help to access his files.
  186.  
  187.  
  188. === Directory "lib/save" ===
  189.  
  190. The "lib/save" directory contains "savefiles" for the players.
  191.  
  192. Each savefile is named "NNN" where "NNN" is the name of the savefile, or,
  193. on some machines, the name of the character, or, on multi-user machines,
  194. "UUU.NNN", where "UUU" is the player uid and "NNN" is the savefile name.
  195.  
  196. The savefiles should be portable between systems, assuming that the
  197. appropriate renaming is perfomed, and any file "type" information is
  198. specified (for the Macintosh).
  199.  
  200.  
  201. === Directory "lib/user" ===
  202.  
  203. The "lib/user" directory contains the "user pref files", if any.
  204.  
  205. In general, these files are used to "customize" aspects of the game for
  206. a given site or a given player.  These files can define "macros" (which
  207. allow a single keypress to perform a complex action), set options (which
  208. affect how the game will handle various situations), and specify visual
  209. mappings for various monsters, objects, or terrain features.
  210.  
  211. See "files.c" for more information on the proper "format" of these files.
  212.  
  213.  
  214. === Directory "lib/xtra" ===
  215.  
  216. The "lib/xtra" directory contains special system files, if any.
  217.  
  218.  
  219. --- Julian Lighton ---
  220.  
  221. (original by Ben Harrison)
  222.